Skip to content

Create bug_report.yml - #371

Merged
jacobtomlinson merged 2 commits into
mainfrom
wscurran-triage-templates
Mar 19, 2026
Merged

Create bug_report.yml#371
jacobtomlinson merged 2 commits into
mainfrom
wscurran-triage-templates

Conversation

@wscurran

@wscurran wscurran commented Mar 19, 2026

Copy link
Copy Markdown
Contributor

This is a v1 template for managing bugs. Applies the label "status: triage"

Summary by CodeRabbit

  • Chores
    • Added a standardized GitHub bug report template. The template requires a "Steps to Reproduce" field and an "Error Logs / Traceback" field (with shell rendering guidance and required validation) so submitted bug reports include consistent, actionable details for triage.

@coderabbitai

coderabbitai Bot commented Mar 19, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: d4cd552f-4bda-4026-a29d-36f9322f9936

📥 Commits

Reviewing files that changed from the base of the PR and between 23935fc and 557a837.

📒 Files selected for processing (1)
  • ISSUE_TEMPLATE/bug_report.yml
🚧 Files skipped from review as they are similar to previous changes (1)
  • ISSUE_TEMPLATE/bug_report.yml

📝 Walkthrough

Walkthrough

Adds a new GitHub issue template file ISSUE_TEMPLATE/bug_report.yml that defines required textareas for steps to reproduce and error logs/traceback.

Changes

Cohort / File(s) Summary
GitHub Issue Template
ISSUE_TEMPLATE/bug_report.yml
Added a Bug Report template containing required Steps to Reproduce and Error Logs / Traceback textarea fields (with labels, placeholder, and validation).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hop to the issue, neat and spry,
A form for bugs beneath the sky,
Steps and logs in tidy rows,
A rabbit's nibble of order grows.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: creating a bug_report.yml template file, which matches the actual changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch wscurran-triage-templates
📝 Coding Plan
  • Generate coding plan for human review comments

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@ISSUE_TEMPLATE/bug_report.yml`:
- Around line 1-3: Move the issue form into .github/ISSUE_TEMPLATE by
renaming/moving the file and add the required top-level description field;
specifically update the current ISSUE_TEMPLATE/bug_report.yml content (which
already contains the name: Bug Report and labels:) to include a description:
line and a proper body: array with the required form fields (e.g., textarea
entries for repro and logs) so the form validates with GitHub’s issue form
schema.
- Around line 1-3: The issue-form YAML is missing the required top-level
"description" key; update ISSUE_TEMPLATE/bug_report.yml by adding a
"description" entry immediately after the existing "name" key (e.g., name: Bug
Report then description: A short summary describing the bug and expected
behavior) so the file contains the required name, description, and body fields
per GitHub issue-form schema.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a1667d25-1072-411a-adef-a42068de996c

📥 Commits

Reviewing files that changed from the base of the PR and between 88a7c40 and 23935fc.

📒 Files selected for processing (1)
  • ISSUE_TEMPLATE/bug_report.yml

Comment thread ISSUE_TEMPLATE/bug_report.yml
@wscurran
wscurran marked this pull request as draft March 19, 2026 00:35

@wscurran wscurran left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to contain all required fields and required folder "ISSUE_TEMPLATE".

@wscurran
wscurran marked this pull request as ready for review March 19, 2026 00:44
@jacobtomlinson
jacobtomlinson merged commit 39112f9 into main Mar 19, 2026
3 checks passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
* Create bug_report.yml

* Update bug_report.yml
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
* Create bug_report.yml

* Update bug_report.yml
ColinM-sys added a commit to ColinM-sys/NemoClaw that referenced this pull request Apr 9, 2026
The file at `ISSUE_TEMPLATE/bug_report.yml` (top level) was added in
PR NVIDIA#371 (\`Create bug_report.yml\`) but landed in the wrong directory.
GitHub only reads issue templates from \`.github/ISSUE_TEMPLATE/\`,
not from a top-level \`ISSUE_TEMPLATE/\` folder, so the file has
never had any effect on the issue creation flow. The four real
templates (\`bug_report.yml\`, \`config.yml\`, \`doc_issue.yml\`,
\`feature_request.yml\`) are correctly placed under
\`.github/ISSUE_TEMPLATE/\` and continue to work.

The dead file also contains a copy-paste artifact: line 2 starts with
a literal \`+description:\` (the leading plus is from a stray diff
fragment), so even if a user manually pointed to this file it would
fail YAML schema validation. No source file or workflow references
the top-level path (\`grep -r "ISSUE_TEMPLATE/bug_report"\` returns
nothing), so removing it is safe.

Removes the unused file and the now-empty parent directory.
@cv
cv deleted the wscurran-triage-templates branch June 28, 2026 00:22
@wscurran wscurran added area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance labels Aug 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build chore Build, CI, dependency, or tooling maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants